Interface com.symantec.itools.vcafe.openapi.VisualRepository 
All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface com.symantec.itools.vcafe.openapi.VisualRepository

public interface VisualRepository
The API used to represent and access the Object Library in a VisualProject and the Component Library in Visual Cafe.

Version:
1.0
Author:
Symantec Internet Tools Division
Since:
VCafe 3.0
See Also:
ComponentLibrary, getComponentLibrary, getObjectLibrary

Method Index

o addObject(VisualObject, VisualObject, VisualObject)
Add a VisualObject to the repository.
o addObjectBefore(VisualObject, VisualObject, VisualObject)
Add a VisualObject to the repository
o getChildren(VisualObject)
Obtain the list of children VisualObjects of a given VisualObject in the repository tree.
o getObject(int)
Obtain a VisualObject with the given id.
o getObjects()
Obtain the list of all top level objects in the repository (children of the Root Object).
o getRootObject()
Obtain the root VisualObject in the repository tree.
o insertObject(VisualObject, VisualObject, int)
Insert a VisualObject at a particular location in the repository
o removeObject(VisualObject)
Remove a given VisualObject from the repository.

Methods

o addObject 
public abstract boolean addObject(VisualObject visualObject,
                                  VisualObject parent,
                                  VisualObject after)
Add a VisualObject to the repository.

Parameters:
visualObject - the object to add.
parent - the parent VisualObject for the given object. If parent is null, then visualObject will be added as child of the Root Object.
after - the VisualObject after which it should be added. If after is null, then visualObject will be added as the last child.
Returns:
true if the object was successfully added.
o addObjectBefore 
public abstract boolean addObjectBefore(VisualObject visualObject,
                                        VisualObject parent,
                                        VisualObject before)
Add a VisualObject to the repository

Parameters:
visualObject - the object to add.
parent - the parent VisualObject for the given object. If the parent is null, then visualObject will be added as a child of the Root Object.
before - the VisualObject before which it should be added. If before is null, then visualObject will be added as the last child.
Returns:
true if the object was successfully added.
o getChildren 
public abstract com.symantec.itools.vcafe.openapi.VisualObject[] getChildren(VisualObject visualObject)
Obtain the list of children VisualObjects of a given VisualObject in the repository tree.

Parameters:
visualObject - the object whose children are to be returned.
Returns:
array of child VisualObjects.
o getObject 
public abstract com.symantec.itools.vcafe.openapi.VisualObject getObject(int objectID)
Obtain a VisualObject with the given id.

Parameters:
objectID - unique id of a VisualObject.
Returns:
VisualObject whose id matches the given id.
o getObjects 
public abstract com.symantec.itools.vcafe.openapi.VisualObject[] getObjects()
Obtain the list of all top level objects in the repository (children of the Root Object).

Returns:
array of top level VisualObjects.
o getRootObject 
public abstract com.symantec.itools.vcafe.openapi.VisualObject getRootObject()
Obtain the root VisualObject in the repository tree. The root VisualObject of a VisualRepository is invisible, but can be used to begin traversing the hierarchy of VisualObjects.

Returns:
VisualObject representing the root of the hierarchy.
o insertObject 
public abstract boolean insertObject(VisualObject visualObject,
                                     VisualObject parent,
                                     int nIndex)
Insert a VisualObject at a particular location in the repository

Parameters:
visualObject - the object to add.
parent - the parent VisualObject for the given object. If the parent is null, then visualObject will be added as a child of the Root Object.
index - relative location where the VisualObject is to be inserted..
Returns:
true if the object was successfully added.
o removeObject 
public abstract boolean removeObject(VisualObject visualObject)
Remove a given VisualObject from the repository.

Parameters:
visualObject - the object to remove. 
All Packages  Class Hierarchy  This Package  Previous  Next  Index